Leadtools.ImageProcessing.Core Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
CorrelationCommand Constructor(RasterImage,Point[],Int32,Int32,Int32)
See Also  Example
Leadtools.ImageProcessing.Core Namespace > CorrelationCommand Class > CorrelationCommand Constructor : CorrelationCommand Constructor(RasterImage,Point[],Int32,Int32,Int32)



correlationImage
RasterImage object that references the image for which to search.
points
An array of Point structures. This array will be updated with the starting points for the correlated areas.
xStep
Step size in the X direction (along image width), in pixels. For best results, use 1. This parameter only accepts positive values.
yStep
Step size in the Y direction (along image height), in pixels. For best results, use 1. This parameter only accepts positive values.
threshold
Value that indicates the correlation threshold, which is a measure of association required to consider two areas to be correlated. If the correlation value between correlationImage and an area in the image to be searched (the Run method image) is less than the correlation threshold they are uncorrelated. Valid values range from 0 (zero resemblance) to 100 (perfect resemblance).
Initializes a new CorrelationCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal correlationImage As RasterImage, _
   ByVal points() As Point, _
   ByVal xStep As Integer, _
   ByVal yStep As Integer, _
   ByVal threshold As Integer _
)
Visual Basic (Usage)Copy Code
Dim correlationImage As RasterImage
Dim points() As Point
Dim xStep As Integer
Dim yStep As Integer
Dim threshold As Integer
 
Dim instance As CorrelationCommand(correlationImage, points, xStep, yStep, threshold)
C# 
public CorrelationCommand( 
   RasterImage correlationImage,
   Point[] points,
   int xStep,
   int yStep,
   int threshold
)
C++/CLI 
public:
CorrelationCommand( 
   RasterImage correlationImage,
   array<Point>^ points,
   int xStep,
   int yStep,
   int threshold
)

Parameters

correlationImage
RasterImage object that references the image for which to search.
points
An array of Point structures. This array will be updated with the starting points for the correlated areas.
xStep
Step size in the X direction (along image width), in pixels. For best results, use 1. This parameter only accepts positive values.
yStep
Step size in the Y direction (along image height), in pixels. For best results, use 1. This parameter only accepts positive values.
threshold
Value that indicates the correlation threshold, which is a measure of association required to consider two areas to be correlated. If the correlation value between correlationImage and an area in the image to be searched (the Run method image) is less than the correlation threshold they are uncorrelated. Valid values range from 0 (zero resemblance) to 100 (perfect resemblance).

Example

Run the CorrelationCommand on an image.

Visual BasicCopy Code
Public Sub CorrelationConstructorExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim points() As System.Drawing.Point
   ReDim points(89)

   Dim DstImage As RasterImage = leadImage.Clone()
   Dim command As CorrelationCommand = New CorrelationCommand(DstImage, points, 1, 1, 70)
   ' Apply the correlation filter.
   command.Run(leadImage)

   MessageBox.Show("The number of points are:" & command.NumberOfPoints.ToString())

   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void CorrelationConstructorExample() 

   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   RasterImage dstImage = image.Clone(); 
   Point [] points = new Point[90]; 
 
   CorrelationCommand command = new CorrelationCommand(dstImage, points, 1, 1, 70); 
   // Apply the correlation filter. 
   command.Run(image); 
 
   MessageBox.Show("The number of points are:" + command.NumberOfPoints.ToString()); 
 
   RasterCodecs.Shutdown(); 
}

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also